solver.datamodel.preferences.Graphics

class ansys.fluent.core.datamodel_231.preferences.Root.Graphics

Bases: PyMenu

Singleton Graphics.

Classes:

AnimationOption	Parameter AnimationOption of value type str.
BoundaryMarkers	Singleton BoundaryMarkers.
ColormapSettings	Singleton ColormapSettings.
DoubleBuffering	Parameter DoubleBuffering of value type bool.
EmbeddedWindows	Singleton EmbeddedWindows.
EnableNonObjectBasedWorkflow	Parameter EnableNonObjectBasedWorkflow of value type bool.
EventPollInterval	Parameter EventPollInterval of value type int.
EventPollTimeout	Parameter EventPollTimeout of value type int.
ExportVideoSettings	Singleton ExportVideoSettings.
ForceKeyFrameAnimationMarkersToOff	Parameter ForceKeyFrameAnimationMarkersToOff of value type bool.
GraphicsEffects	Singleton GraphicsEffects.
GraphicsWindowLineWidth	Parameter GraphicsWindowLineWidth of value type str.
GraphicsWindowPointSymbol	Parameter GraphicsWindowPointSymbol of value type str.
HardcopySettings	Singleton HardcopySettings.
HiddenSurfaceRemovalMethod	Parameter HiddenSurfaceRemovalMethod of value type str.
HigherResolutionGraphicsWindowLineWidth	Parameter HigherResolutionGraphicsWindowLineWidth of value type float.
Lighting	Singleton Lighting.
LowerResolutionGraphicsWindowLineWidth	Parameter LowerResolutionGraphicsWindowLineWidth of value type float.
ManageHoopsMemory	Singleton ManageHoopsMemory.
MarkerDrawingMode	Parameter MarkerDrawingMode of value type str.
MaterialEffects	Singleton MaterialEffects.
MaxGraphicsTextSize	Parameter MaxGraphicsTextSize of value type int.
MeshingMode	Singleton MeshingMode.
MinGraphicsTextSize	Parameter MinGraphicsTextSize of value type int.
Performance	Singleton Performance.
PlotLegendMargin	Parameter PlotLegendMargin of value type float.
PointToolSize	Parameter PointToolSize of value type float.
RemovePartitionLines	Parameter RemovePartitionLines of value type bool.
RemovePartitionLinesTolerance	Parameter RemovePartitionLinesTolerance of value type float.
RotationCenterpointVisible	Parameter RotationCenterpointVisible of value type bool.
ScrollWheelEventEndTimer	Parameter ScrollWheelEventEndTimer of value type int.
SetCameraNormalToSurfaceIncrements	Parameter SetCameraNormalToSurfaceIncrements of value type int.
ShowHiddenLines	Parameter ShowHiddenLines of value type bool.
ShowHiddenSurfaces	Parameter ShowHiddenSurfaces of value type bool.
SwitchToOpenGLForRemoteVisualization	Parameter SwitchToOpenGLForRemoteVisualization of value type bool.
TestUseExternalFunction	Parameter TestUseExternalFunction of value type str.
TextWindowLineWidth	Parameter TextWindowLineWidth of value type str.
Transparency	Singleton Transparency.
VectorSettings	Singleton VectorSettings.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AnimationOption

Bases: PyTextual

Parameter AnimationOption of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BoundaryMarkers

Bases: PyMenu

Singleton BoundaryMarkers.

Classes:

ColorOption	Parameter ColorOption of value type str.
Enabled	Parameter Enabled of value type bool.
ExcludeFromBounding	Parameter ExcludeFromBounding of value type bool.
InletColor	Parameter InletColor of value type str.
MarkerFraction	Parameter MarkerFraction of value type float.
MarkerSizeLimitingScaleMultiplier	Parameter MarkerSizeLimitingScaleMultiplier of value type float.
MarkersLimit	Parameter MarkersLimit of value type int.
OutletColor	Parameter OutletColor of value type str.
ScaleMarker	Parameter ScaleMarker of value type float.
ShowInletMarkers	Parameter ShowInletMarkers of value type bool.
ShowOutletMarkers	Parameter ShowOutletMarkers of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class ColorOption

Bases: PyTextual

Parameter ColorOption of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Enabled

Bases: PyParameter

Parameter Enabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ExcludeFromBounding

Bases: PyParameter

Parameter ExcludeFromBounding of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class InletColor

Bases: PyTextual

Parameter InletColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkerFraction

Bases: PyNumerical

Parameter MarkerFraction of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkerSizeLimitingScaleMultiplier

Bases: PyNumerical

Parameter MarkerSizeLimitingScaleMultiplier of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkersLimit

Bases: PyNumerical

Parameter MarkersLimit of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class OutletColor

Bases: PyTextual

Parameter OutletColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ScaleMarker

Bases: PyNumerical

Parameter ScaleMarker of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowInletMarkers

Bases: PyParameter

Parameter ShowInletMarkers of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowOutletMarkers

Bases: PyParameter

Parameter ShowOutletMarkers of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ColormapSettings

Bases: PyMenu

Singleton ColormapSettings.

Classes:

Alignment	Parameter Alignment of value type str.
AspectRatioWhenHorizontal	Parameter AspectRatioWhenHorizontal of value type float.
AspectRatioWhenVertical	Parameter AspectRatioWhenVertical of value type float.
AutoRefitOnResize	Parameter AutoRefitOnResize of value type bool.
AutomaticResize	Parameter AutomaticResize of value type bool.
BorderStyle	Parameter BorderStyle of value type str.
Colormap	Parameter Colormap of value type str.
IsolinesPositionOffset	Parameter IsolinesPositionOffset of value type float.
Labels	Parameter Labels of value type bool.
Levels	Parameter Levels of value type int.
LogScale	Parameter LogScale of value type bool.
MajorLengthToScreenRatioWhenHorizontal	Parameter MajorLengthToScreenRatioWhenHorizontal of value type float.
MajorLengthToScreenRatioWhenVertical	Parameter MajorLengthToScreenRatioWhenVertical of value type float.
MarginFromEdgeToScreenRatio	Parameter MarginFromEdgeToScreenRatio of value type float.
MaxSizeScaleFactor	Parameter MaxSizeScaleFactor of value type float.
MinSizeScaleFactor	Parameter MinSizeScaleFactor of value type float.
NumberFormatPrecision	Parameter NumberFormatPrecision of value type int.
NumberFormatType	Parameter NumberFormatType of value type str.
PreserveAspectRatioForHardcopy	Parameter PreserveAspectRatioForHardcopy of value type bool.
ShowColormap	Parameter ShowColormap of value type bool.
SkipValue	Parameter SkipValue of value type int.
TextBehavior	Parameter TextBehavior of value type str.
TextFontAutomaticHorizontalSize	Parameter TextFontAutomaticHorizontalSize of value type float.
TextFontAutomaticSize	Parameter TextFontAutomaticSize of value type float.
TextFontAutomaticUnits	Parameter TextFontAutomaticUnits of value type str.
TextFontAutomaticVerticalSize	Parameter TextFontAutomaticVerticalSize of value type float.
TextFontFixedHorizontalSize	Parameter TextFontFixedHorizontalSize of value type int.
TextFontFixedSize	Parameter TextFontFixedSize of value type int.
TextFontFixedUnits	Parameter TextFontFixedUnits of value type str.
TextFontFixedVerticalSize	Parameter TextFontFixedVerticalSize of value type int.
TextFontName	Parameter TextFontName of value type str.
TextTruncationLimitForHorizontalColormaps	Parameter TextTruncationLimitForHorizontalColormaps of value type int.
TextTruncationLimitForVerticalColormaps	Parameter TextTruncationLimitForVerticalColormaps of value type int.
Type	Parameter Type of value type str.
UseNoSubWindows	Parameter UseNoSubWindows of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Alignment

Bases: PyTextual

Parameter Alignment of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AspectRatioWhenHorizontal

Bases: PyNumerical

Parameter AspectRatioWhenHorizontal of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AspectRatioWhenVertical

Bases: PyNumerical

Parameter AspectRatioWhenVertical of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AutoRefitOnResize

Bases: PyParameter

Parameter AutoRefitOnResize of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AutomaticResize

Bases: PyParameter

Parameter AutomaticResize of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BorderStyle

Bases: PyTextual

Parameter BorderStyle of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Colormap

Bases: PyTextual

Parameter Colormap of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class IsolinesPositionOffset

Bases: PyNumerical

Parameter IsolinesPositionOffset of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Labels

Bases: PyParameter

Parameter Labels of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Levels

Bases: PyNumerical

Parameter Levels of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LogScale

Bases: PyParameter

Parameter LogScale of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MajorLengthToScreenRatioWhenHorizontal

Bases: PyNumerical

Parameter MajorLengthToScreenRatioWhenHorizontal of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MajorLengthToScreenRatioWhenVertical

Bases: PyNumerical

Parameter MajorLengthToScreenRatioWhenVertical of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarginFromEdgeToScreenRatio

Bases: PyNumerical

Parameter MarginFromEdgeToScreenRatio of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MaxSizeScaleFactor

Bases: PyNumerical

Parameter MaxSizeScaleFactor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MinSizeScaleFactor

Bases: PyNumerical

Parameter MinSizeScaleFactor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class NumberFormatPrecision

Bases: PyNumerical

Parameter NumberFormatPrecision of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class NumberFormatType

Bases: PyTextual

Parameter NumberFormatType of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PreserveAspectRatioForHardcopy

Bases: PyParameter

Parameter PreserveAspectRatioForHardcopy of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowColormap

Bases: PyParameter

Parameter ShowColormap of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SkipValue

Bases: PyNumerical

Parameter SkipValue of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextBehavior

Bases: PyTextual

Parameter TextBehavior of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontAutomaticHorizontalSize

Bases: PyNumerical

Parameter TextFontAutomaticHorizontalSize of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontAutomaticSize

Bases: PyNumerical

Parameter TextFontAutomaticSize of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontAutomaticUnits

Bases: PyTextual

Parameter TextFontAutomaticUnits of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontAutomaticVerticalSize

Bases: PyNumerical

Parameter TextFontAutomaticVerticalSize of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontFixedHorizontalSize

Bases: PyNumerical

Parameter TextFontFixedHorizontalSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontFixedSize

Bases: PyNumerical

Parameter TextFontFixedSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontFixedUnits

Bases: PyTextual

Parameter TextFontFixedUnits of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontFixedVerticalSize

Bases: PyNumerical

Parameter TextFontFixedVerticalSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextFontName

Bases: PyTextual

Parameter TextFontName of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextTruncationLimitForHorizontalColormaps

Bases: PyNumerical

Parameter TextTruncationLimitForHorizontalColormaps of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextTruncationLimitForVerticalColormaps

Bases: PyNumerical

Parameter TextTruncationLimitForVerticalColormaps of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Type

Bases: PyTextual

Parameter Type of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class UseNoSubWindows

Bases: PyParameter

Parameter UseNoSubWindows of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DoubleBuffering

Bases: PyParameter

Parameter DoubleBuffering of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EmbeddedWindows

Bases: PyMenu

Singleton EmbeddedWindows.

Classes:

DefaultEmbeddedMeshWindowsView	Parameter DefaultEmbeddedMeshWindowsView of value type bool.
DefaultEmbeddedWindowsView	Parameter DefaultEmbeddedWindowsView of value type bool.
SaveEmbeddedWindowLayout	Parameter SaveEmbeddedWindowLayout of value type bool.
ShowBorderForEmbeddedWindow	Parameter ShowBorderForEmbeddedWindow of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class DefaultEmbeddedMeshWindowsView

Bases: PyParameter

Parameter DefaultEmbeddedMeshWindowsView of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DefaultEmbeddedWindowsView

Bases: PyParameter

Parameter DefaultEmbeddedWindowsView of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SaveEmbeddedWindowLayout

Bases: PyParameter

Parameter SaveEmbeddedWindowLayout of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowBorderForEmbeddedWindow

Bases: PyParameter

Parameter ShowBorderForEmbeddedWindow of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EnableNonObjectBasedWorkflow

Bases: PyParameter

Parameter EnableNonObjectBasedWorkflow of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EventPollInterval

Bases: PyNumerical

Parameter EventPollInterval of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EventPollTimeout

Bases: PyNumerical

Parameter EventPollTimeout of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ExportVideoSettings

Bases: PyMenu

Singleton ExportVideoSettings.

Classes:

AdvancedVideoQualityOptions	Singleton AdvancedVideoQualityOptions.
VideoFPS	Parameter VideoFPS of value type int.
VideoFormat	Parameter VideoFormat of value type str.
VideoQuality	Parameter VideoQuality of value type str.
VideoResoutionX	Parameter VideoResoutionX of value type int.
VideoResoutionY	Parameter VideoResoutionY of value type int.
VideoScale	Parameter VideoScale of value type str.
VideoSmoothScaling	Parameter VideoSmoothScaling of value type bool.
VideoUseFrameResolution	Parameter VideoUseFrameResolution of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AdvancedVideoQualityOptions

Bases: PyMenu

Singleton AdvancedVideoQualityOptions.

Classes:

BitRateQuality	Parameter BitRateQuality of value type str.
Bitrate	Parameter Bitrate of value type int.
CompressionMethod	Parameter CompressionMethod of value type str.
EnableH264	Parameter EnableH264 of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class BitRateQuality

Bases: PyTextual

Parameter BitRateQuality of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Bitrate

Bases: PyNumerical

Parameter Bitrate of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class CompressionMethod

Bases: PyTextual

Parameter CompressionMethod of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class EnableH264

Bases: PyParameter

Parameter EnableH264 of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoFPS

Bases: PyNumerical

Parameter VideoFPS of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoFormat

Bases: PyTextual

Parameter VideoFormat of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoQuality

Bases: PyTextual

Parameter VideoQuality of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoResoutionX

Bases: PyNumerical

Parameter VideoResoutionX of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoResoutionY

Bases: PyNumerical

Parameter VideoResoutionY of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoScale

Bases: PyTextual

Parameter VideoScale of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoSmoothScaling

Bases: PyParameter

Parameter VideoSmoothScaling of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VideoUseFrameResolution

Bases: PyParameter

Parameter VideoUseFrameResolution of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ForceKeyFrameAnimationMarkersToOff

Bases: PyParameter

Parameter ForceKeyFrameAnimationMarkersToOff of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsEffects

Bases: PyMenu

Singleton GraphicsEffects.

Classes:

AmbientOcclusionEnabled	Parameter AmbientOcclusionEnabled of value type bool.
AmbientOcclusionQuality	Parameter AmbientOcclusionQuality of value type str.
AmbientOcclusionStrength	Parameter AmbientOcclusionStrength of value type int.
AntiAliasing	Parameter AntiAliasing of value type bool.
BloomBlur	Parameter BloomBlur of value type int.
BloomEnabled	Parameter BloomEnabled of value type bool.
BloomStrength	Parameter BloomStrength of value type int.
GridColor	Parameter GridColor of value type str.
GridPlaneCount	Parameter GridPlaneCount of value type int.
GridPlaneEnabled	Parameter GridPlaneEnabled of value type bool.
GridPlaneOffset	Parameter GridPlaneOffset of value type int.
GridPlaneSizeFactor	Parameter GridPlaneSizeFactor of value type int.
PlaneDirection	Parameter PlaneDirection of value type str.
ReflectionsEnabled	Parameter ReflectionsEnabled of value type bool.
ShadowMapEnabled	Parameter ShadowMapEnabled of value type bool.
ShowEdgeReflections	Parameter ShowEdgeReflections of value type bool.
ShowMarkerReflections	Parameter ShowMarkerReflections of value type bool.
SimpleShadowsEnabled	Parameter SimpleShadowsEnabled of value type bool.
UpdateAfterMouseRelease	Parameter UpdateAfterMouseRelease of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AmbientOcclusionEnabled

Bases: PyParameter

Parameter AmbientOcclusionEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AmbientOcclusionQuality

Bases: PyTextual

Parameter AmbientOcclusionQuality of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AmbientOcclusionStrength

Bases: PyNumerical

Parameter AmbientOcclusionStrength of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class AntiAliasing

Bases: PyParameter

Parameter AntiAliasing of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BloomBlur

Bases: PyNumerical

Parameter BloomBlur of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BloomEnabled

Bases: PyParameter

Parameter BloomEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class BloomStrength

Bases: PyNumerical

Parameter BloomStrength of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridColor

Bases: PyTextual

Parameter GridColor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridPlaneCount

Bases: PyNumerical

Parameter GridPlaneCount of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridPlaneEnabled

Bases: PyParameter

Parameter GridPlaneEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridPlaneOffset

Bases: PyNumerical

Parameter GridPlaneOffset of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GridPlaneSizeFactor

Bases: PyNumerical

Parameter GridPlaneSizeFactor of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PlaneDirection

Bases: PyTextual

Parameter PlaneDirection of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ReflectionsEnabled

Bases: PyParameter

Parameter ReflectionsEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShadowMapEnabled

Bases: PyParameter

Parameter ShadowMapEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowEdgeReflections

Bases: PyParameter

Parameter ShowEdgeReflections of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowMarkerReflections

Bases: PyParameter

Parameter ShowMarkerReflections of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SimpleShadowsEnabled

Bases: PyParameter

Parameter SimpleShadowsEnabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class UpdateAfterMouseRelease

Bases: PyParameter

Parameter UpdateAfterMouseRelease of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsWindowLineWidth

Bases: PyTextual

Parameter GraphicsWindowLineWidth of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsWindowPointSymbol

Bases: PyTextual

Parameter GraphicsWindowPointSymbol of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HardcopySettings

Bases: PyMenu

Singleton HardcopySettings.

Classes:

ExportEdgesForAVZ	Parameter ExportEdgesForAVZ of value type bool.
HardcopyDriver	Parameter HardcopyDriver of value type str.
HardcopyLineWidth	Parameter HardcopyLineWidth of value type int.
HardwareImageAccel	Parameter HardwareImageAccel of value type bool.
PostScriptPermissionOverride	Parameter PostScriptPermissionOverride of value type bool.
SaveEmbeddedHardcopiesSeparately	Parameter SaveEmbeddedHardcopiesSeparately of value type bool.
SaveEmbeddedWindowsInHardcopy	Parameter SaveEmbeddedWindowsInHardcopy of value type bool.
TransparentEmbeddedWindows	Parameter TransparentEmbeddedWindows of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class ExportEdgesForAVZ

Bases: PyParameter

Parameter ExportEdgesForAVZ of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HardcopyDriver

Bases: PyTextual

Parameter HardcopyDriver of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HardcopyLineWidth

Bases: PyNumerical

Parameter HardcopyLineWidth of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HardwareImageAccel

Bases: PyParameter

Parameter HardwareImageAccel of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PostScriptPermissionOverride

Bases: PyParameter

Parameter PostScriptPermissionOverride of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SaveEmbeddedHardcopiesSeparately

Bases: PyParameter

Parameter SaveEmbeddedHardcopiesSeparately of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SaveEmbeddedWindowsInHardcopy

Bases: PyParameter

Parameter SaveEmbeddedWindowsInHardcopy of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TransparentEmbeddedWindows

Bases: PyParameter

Parameter TransparentEmbeddedWindows of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HiddenSurfaceRemovalMethod

Bases: PyTextual

Parameter HiddenSurfaceRemovalMethod of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HigherResolutionGraphicsWindowLineWidth

Bases: PyNumerical

Parameter HigherResolutionGraphicsWindowLineWidth of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Lighting

Bases: PyMenu

Singleton Lighting.

Classes:

AmbientLightIntensity	Parameter AmbientLightIntensity of value type float.
Headlight	Parameter Headlight of value type str.
HeadlightIntensity	Parameter HeadlightIntensity of value type float.
LightingMethod	Parameter LightingMethod of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AmbientLightIntensity

Bases: PyNumerical

Parameter AmbientLightIntensity of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Headlight

Bases: PyTextual

Parameter Headlight of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HeadlightIntensity

Bases: PyNumerical

Parameter HeadlightIntensity of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LightingMethod

Bases: PyTextual

Parameter LightingMethod of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LowerResolutionGraphicsWindowLineWidth

Bases: PyNumerical

Parameter LowerResolutionGraphicsWindowLineWidth of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ManageHoopsMemory

Bases: PyMenu

Singleton ManageHoopsMemory.

Classes:

Enabled	Parameter Enabled of value type bool.
HSFImportLimit	Parameter HSFImportLimit of value type int.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Enabled

Bases: PyParameter

Parameter Enabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class HSFImportLimit

Bases: PyNumerical

Parameter HSFImportLimit of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkerDrawingMode

Bases: PyTextual

Parameter MarkerDrawingMode of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MaterialEffects

Bases: PyMenu

Singleton MaterialEffects.

Classes:

DecimationFilter	Parameter DecimationFilter of value type str.
ParameterizationSource	Parameter ParameterizationSource of value type str.
TilingStyle	Parameter TilingStyle of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class DecimationFilter

Bases: PyTextual

Parameter DecimationFilter of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ParameterizationSource

Bases: PyTextual

Parameter ParameterizationSource of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TilingStyle

Bases: PyTextual

Parameter TilingStyle of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MaxGraphicsTextSize

Bases: PyNumerical

Parameter MaxGraphicsTextSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MeshingMode

Bases: PyMenu

Singleton MeshingMode.

Classes:

GraphicsWindowDisplayTimeout	Parameter GraphicsWindowDisplayTimeout of value type bool.
GraphicsWindowDisplayTimeoutValue	Parameter GraphicsWindowDisplayTimeoutValue of value type float.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class GraphicsWindowDisplayTimeout

Bases: PyParameter

Parameter GraphicsWindowDisplayTimeout of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class GraphicsWindowDisplayTimeoutValue

Bases: PyNumerical

Parameter GraphicsWindowDisplayTimeoutValue of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MinGraphicsTextSize

Bases: PyNumerical

Parameter MinGraphicsTextSize of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Performance

Bases: PyMenu

Singleton Performance.

Classes:

FastDisplayMode	Singleton FastDisplayMode.
MinimumFrameRate	Singleton MinimumFrameRate.
OptimizeFor	Parameter OptimizeFor of value type str.
RatioOfTargetFrameRateToClassifyHeavyGeometry	Parameter RatioOfTargetFrameRateToClassifyHeavyGeometry of value type float.
RatioOfTargetFrameRateToDeclassifyHeavyGeometry	Parameter RatioOfTargetFrameRateToDeclassifyHeavyGeometry of value type float.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class FastDisplayMode

Bases: PyMenu

Singleton FastDisplayMode.

Classes:

Culling	Parameter Culling of value type int.
FacesShown	Parameter FacesShown of value type bool.
MarkersDecimation	Parameter MarkersDecimation of value type float.
NodesShown	Parameter NodesShown of value type bool.
PerimeterEdgesShown	Parameter PerimeterEdgesShown of value type bool.
SilhouetteShown	Parameter SilhouetteShown of value type bool.
Status	Parameter Status of value type str.
Transparency	Parameter Transparency of value type bool.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Culling

Bases: PyNumerical

Parameter Culling of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class FacesShown

Bases: PyParameter

Parameter FacesShown of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MarkersDecimation

Bases: PyNumerical

Parameter MarkersDecimation of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class NodesShown

Bases: PyParameter

Parameter NodesShown of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PerimeterEdgesShown

Bases: PyParameter

Parameter PerimeterEdgesShown of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SilhouetteShown

Bases: PyParameter

Parameter SilhouetteShown of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Status

Bases: PyTextual

Parameter Status of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Transparency

Bases: PyParameter

Parameter Transparency of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MinimumFrameRate

Bases: PyMenu

Singleton MinimumFrameRate.

Classes:

DynamicAdjustment	Parameter DynamicAdjustment of value type bool.
Enabled	Parameter Enabled of value type bool.
FixedCullingValue	Parameter FixedCullingValue of value type int.
MaximumCullingThreshold	Parameter MaximumCullingThreshold of value type int.
MinimumCullingThreshold	Parameter MinimumCullingThreshold of value type int.
TargetFPS	Parameter TargetFPS of value type int.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class DynamicAdjustment

Bases: PyParameter

Parameter DynamicAdjustment of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Enabled

Bases: PyParameter

Parameter Enabled of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class FixedCullingValue

Bases: PyNumerical

Parameter FixedCullingValue of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MaximumCullingThreshold

Bases: PyNumerical

Parameter MaximumCullingThreshold of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class MinimumCullingThreshold

Bases: PyNumerical

Parameter MinimumCullingThreshold of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TargetFPS

Bases: PyNumerical

Parameter TargetFPS of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class OptimizeFor

Bases: PyTextual

Parameter OptimizeFor of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RatioOfTargetFrameRateToClassifyHeavyGeometry

Bases: PyNumerical

Parameter RatioOfTargetFrameRateToClassifyHeavyGeometry of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RatioOfTargetFrameRateToDeclassifyHeavyGeometry

Bases: PyNumerical

Parameter RatioOfTargetFrameRateToDeclassifyHeavyGeometry of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PlotLegendMargin

Bases: PyNumerical

Parameter PlotLegendMargin of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class PointToolSize

Bases: PyNumerical

Parameter PointToolSize of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RemovePartitionLines

Bases: PyParameter

Parameter RemovePartitionLines of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RemovePartitionLinesTolerance

Bases: PyNumerical

Parameter RemovePartitionLinesTolerance of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class RotationCenterpointVisible

Bases: PyParameter

Parameter RotationCenterpointVisible of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ScrollWheelEventEndTimer

Bases: PyNumerical

Parameter ScrollWheelEventEndTimer of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SetCameraNormalToSurfaceIncrements

Bases: PyNumerical

Parameter SetCameraNormalToSurfaceIncrements of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowHiddenLines

Bases: PyParameter

Parameter ShowHiddenLines of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ShowHiddenSurfaces

Bases: PyParameter

Parameter ShowHiddenSurfaces of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class SwitchToOpenGLForRemoteVisualization

Bases: PyParameter

Parameter SwitchToOpenGLForRemoteVisualization of value type bool.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TestUseExternalFunction

Bases: PyTextual

Parameter TestUseExternalFunction of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class TextWindowLineWidth

Bases: PyTextual

Parameter TextWindowLineWidth of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Transparency

Bases: PyMenu

Singleton Transparency.

Classes:

AlgorithmForModernDrivers	Parameter AlgorithmForModernDrivers of value type str.
DepthPeelingLayers	Parameter DepthPeelingLayers of value type int.
DepthPeelingPreference	Parameter DepthPeelingPreference of value type str.
QuickMoves	Parameter QuickMoves of value type str.
ZSortOptions	Parameter ZSortOptions of value type str.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class AlgorithmForModernDrivers

Bases: PyTextual

Parameter AlgorithmForModernDrivers of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DepthPeelingLayers

Bases: PyNumerical

Parameter DepthPeelingLayers of value type int.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class DepthPeelingPreference

Bases: PyTextual

Parameter DepthPeelingPreference of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class QuickMoves

Bases: PyTextual

Parameter QuickMoves of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class ZSortOptions

Bases: PyTextual

Parameter ZSortOptions of value type str.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
allowed_values()
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

allowed_values()

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class VectorSettings

Bases: PyMenu

Singleton VectorSettings.

Classes:

Arrow3DRadius1Factor	Parameter Arrow3DRadius1Factor of value type float.
Arrow3DRadius2Factor	Parameter Arrow3DRadius2Factor of value type float.
Arrowhead3DRadius1Factor	Parameter Arrowhead3DRadius1Factor of value type float.
LineArrow3DPerpendicularRadius	Parameter LineArrow3DPerpendicularRadius of value type float.

Methods:

__init__(service, rules, path)	__init__ method of PyMenu class.
add_on_affected(cb)	Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)	Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
add_on_child_created(child_type, cb)	Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)	Register a callback for when an attribute is changed
create_command_arguments(command)	Create command arguments.
delete_all_child_objects()
delete_child()
delete_child_objects()
fix_state()
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
name()	Get the name of the named object.
rename(new_name)	Rename the named object.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

class Arrow3DRadius1Factor

Bases: PyNumerical

Parameter Arrow3DRadius1Factor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Arrow3DRadius2Factor

Bases: PyNumerical

Parameter Arrow3DRadius2Factor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class Arrowhead3DRadius1Factor

Bases: PyNumerical

Parameter Arrowhead3DRadius1Factor of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

class LineArrow3DPerpendicularRadius

Bases: PyNumerical

Parameter LineArrow3DPerpendicularRadius of value type float.

Methods:

__init__(service, rules[, path])	__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)	Register a callback for when an attribute is changed
add_on_changed(cb)	Register a callback for when the object is modified.
default_value()	Get default value of the parameter.
getAttribValue(attrib)	Get attribute value of the current object.
getState()	Get state of the current object.
get_attr(attrib)	Get attribute value of the current object.
get_state()	Get state of the current object.
help()	Print help string.
is_active()	Returns true if the parameter is active.
is_read_only()	Checks whether the parameter is read only.
max()	Maximum value of the numerical parameter.
min()	Minimum value of the numerical parameter.
setState([state])	Set state of the current object.
set_state([state])	Set state of the current object.

Attributes:

docstring

__init__(service, rules, path=None)

__init__ method of PyStateContainer class.

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

default_value()

Get default value of the parameter.

docstring = None

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

is_read_only()

Checks whether the parameter is read only.

max()

Maximum value of the numerical parameter.

min()

Minimum value of the numerical parameter.

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None

__init__(service, rules, path)

__init__ method of PyMenu class.

add_on_affected(cb)

Register a callback for when the object is affected.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_affected_at_type_path(child_type, cb)

Register a callback for when the object is affected at child type

Parameters:

child_typestr

child type

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_attribute_changed(attribute, cb)

Register a callback for when an attribute is changed

Parameters:

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_changed(cb)

Register a callback for when the object is modified.

Parameters:

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_child_created(child_type, cb)

Register a callback for when a child object is created.

Parameters:

child_typestr

Type of the child object

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

add_on_command_attribute_changed(command, attribute, cb)

Register a callback for when an attribute is changed

Parameters:

commandstr

command name

attributestr

attribute name

cbCallable

Callback function

Returns:

EventSubscription

EventSubscription instance which can be used to unregister the callback

Return type:

EventSubscription

create_command_arguments(command)

Create command arguments.

Parameters:

commandstr

Command name

Returns:

str

Command id

Return type:

str

delete_all_child_objects()

delete_child()

delete_child_objects()

docstring = None

fix_state()

getAttribValue(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

getState()

Get state of the current object.

Return type:

Any

get_attr(attrib)

Get attribute value of the current object.

Parameters:

attribstr

Name of the attribute.

Returns:

Any

Value of the attribute.

Return type:

Any

get_state()

Get state of the current object.

Return type:

Any

help()

Print help string.

Return type:

None

is_active()

Returns true if the parameter is active.

name()

Get the name of the named object.

rename(new_name)

Rename the named object.

Parameters:

new_namestr

New name for the object.

Return type:

None

setState(state=None, **kwargs)

Set state of the current object.

Return type:

None

set_state(state=None, **kwargs)

Set state of the current object.

Return type:

None